CIMPLICITY Configuration REST API Web Service
CIMPLICITY Configuration REST API Web Service / All Operations Resource Group / /projects/{projectId}/roles (Get)
In This Topic
    Get/projects/{projectId}/roles
    In This Topic
    Description
    returns a list of roles in a project that satisfy the filter criteria
    Parameters
    NameDescriptionData Type
    projectIdthe id of the project to look instring
    skipnumber of records to skip for paginationinteger (int32)
    limitmaximum number of records to returninteger (int32)
    RoleIDprovides a wild card string to filter roles by their RoleID.string
    200 Response

    The response body is of type RolesGetResponse.

    The collection of roles that satisfy the query.

    Overview

    RolesGetResponse
    The results of the roles get query.
    Roles : Array[CimRole]
    Configuration : CimConfigurationPrivileges
    Alarms : boolean
    Classes : boolean
    Clients : boolean
    DatabaseLogging : boolean
    Devices : boolean
    GlobalParameters : boolean
    Objects : boolean
    Points : boolean
    Ports : boolean
    Projects : boolean
    RemoteProjects : boolean
    Resources : boolean
    Roles : boolean
    Users : boolean
    WebConfigEnable : boolean
    Workbench : boolean
    Privileges : CimPrivileges
    ChangeApprovalVerify : boolean
    DeleteAlarms : boolean
    DisableOrModifyAlarms : boolean
    DynamicConfiguration : boolean
    ModifyAlarmSetups : boolean
    ModifyAttributes : boolean
    OPCUAServerAdmin : boolean
    PointByAddress : boolean
    PointTarget : boolean
    ProcessControl : boolean
    RightClickMenu : boolean
    ScriptControl : boolean
    SetPoint : boolean
    SetpointAuditTrail : boolean
    StartProject : boolean
    StopProject : boolean
    TriggerEvents : boolean
    Level : integer
    RoleID : string
    Fault Responses
    FaultDescription
    404This fault returns a response body of type ProblemDetails.
    project with the given id is not registered on the system
    See Also
    All Operations Resource Group | CIMPLICITY Configuration REST API Web Service

     

     

    © 2024 GE Vernova and/or its affiliates. All rights reserved.

    Send comments on this topic.